home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / dviware / dvidis / dvidis.doc < prev    next >
Text File  |  1990-10-01  |  11KB  |  266 lines

  1.  
  2.         This documentation corresponds to DVIDIS V3.4
  3.  
  4.  
  5. DVIDIS is a program that displays TeX DVI files on a VaxStation running VWS.
  6.  
  7.                   N O T E
  8.  
  9.     If you have used previous versions of DVIDIS, note that this
  10.     version is VERY different.  The human interface is much better,
  11.     but most important, the program now reads PK format font files,
  12.     note the old, very obsolete RST format font files.  It is possible
  13.     to build a version with RST file support, but that hasn't been
  14.     tested and is not recommended.  PK fonts are MUCH better in every way.
  15.  
  16. Basic usage is very simple.  To display file TEXT.DVI, for example, just type:
  17.         $ DVIDIS TEXT
  18.  
  19. on your VAXStation.  A large window will be created, and your text should
  20. start to appear in it; depending on the paper size and where you have located
  21. your window (by default it starts out centered), you may be able to see the
  22. "edge" of the paper as a gray bar.  Meanwhile, your keyboard will remain
  23. attached to the window you were previously in, and you can enter commands.
  24. For a list of commands available to you, hit the HELP key.  The effect of
  25. the various commands is easy to see, so experiment until you feel comfortable
  26. with them.
  27.  
  28. You can also specify a couple of options on the DVIDIS command line.  These
  29. CANNOT be changed once DVIDIS has started.  All options are of the form "-l"
  30. where "l" is any single letter, with the single exception of -verbose (for
  31. historical reasons).  Some are followed - after a space - by one or a pair of
  32. numeric arguments; the -s command must be followed  by a paper size specifica-
  33. tion.
  34.  
  35. For example:
  36.  
  37.         $ DVIDIS -w -p 2 4 TEXT
  38.  
  39. means "display pages 2 to 4 of TEXT.DVI in 'wide' mode."
  40.  
  41. The following options are commonly used:
  42.  
  43. -c    The fonts that DVIDIS uses are meant for a 300 dpi printer.  A VAXSta-
  44.     tion display has about 78 dpi.  As a result, if you display the glyphs
  45.     from these fonts at a 1-1 pixel-to-pixel mapping, they are about 4
  46.     times as large as they would be on the page, and only about 1/9 of the
  47.     page is visible at a time.  Normally, DVIDIS compresses all fonts by a
  48.     2-to-1 factor.  The fonts are still readable, but you can now get most
  49.     of the width of a page - all, with any reasonable margins - and over
  50.     half the height on the screen.  Specifying "-c" turns off this com-
  51.     pression; it's useful mainly for looking at the glyphs, not the text.
  52.  
  53. -w    Specifies a 4-to-1 glyph compression factor.  This allows you to see
  54.     how a whole page looks, but unfortunately it's rather hard to read
  55.     the resulting text.
  56.  
  57. -m    Tells DVIDIS to try to use smaller fonts, rather than compressing
  58.     larger ones.  This only works if you actually HAVE the small fonts on
  59.     your system.  When it works, it improves the appearance of individual
  60.     characters, although it often makes lines come out with slightly
  61.     different lengths than they should.  -m is especially useful in
  62.     conjunction with -w.  -m in conjunction with -c is meaningless.
  63.  
  64. -s ss    Set the paper size.  This determines what size paper the program
  65.     assumes you are printing on.  The default is "letter", which is
  66.     8.5 x 11 inch es.  The argument is the name of a paper size; type
  67.     DVIDIS -s ? for a list of possible values.
  68.  
  69.     The paper size controls where DVIDIS places a visible gray border,
  70.     and when it tells you that characters have "run off the page".  It
  71.     always displays the characters, however.
  72.  
  73.     Paper size "huge" is meant for special purposes; using it will make
  74.     many of the commands you can type to DVIDIS while it is running work
  75.     in strange ways.  You should generally avoid using size "huge".
  76.  
  77. -verbose
  78.     Makes the program talkative.  This is mainly useful for debugging,
  79.     but since it displays all the font files it opens, successfully or
  80.     not, it can be used to determine which files are needed.  The needed
  81.     files can be created if they don't already exist.  They can also be
  82.     put on your workstation's local disk to improve performance.
  83.  
  84. The rest of the options are rarely used:
  85.  
  86. -v <mi>, -h <mi>
  87.     Set the vertical (horizonal) margin.  Next argument is the margin, in
  88.     milli-inches.  Default is 1000 milli-inches each, which is the same
  89.     default used by many common DVI printing programs.  If you find a lot
  90.     of "off-screen glyph" errors, and you have the paper size set cor-
  91.     rectly, try changing these parameters.  (Besides 1000, the second
  92.     most common value expected is 0 for both margins.)
  93.  
  94.     Note that the default corresponds to the current TeX standard.  If
  95.     you find you have to use some other value to make your output look
  96.     right, some other piece of software you are running is obsolete.
  97.  
  98. -p <s> <e>
  99.     Limits the display to pages <s> through <e> inclusive.  You can only
  100.     specify one page range at a time, but you can specify multiple -p
  101.     options, each specifying a page range.  When you specify page ranges,
  102.     DVIDIS will only "see" pages within the ranges given.  Nothing you
  103.     can do while the program is running will let you display any page
  104.     not within any page range - DVIDIS will simply skip past the pages.
  105.  
  106. -f    Causes the program to look in "USER$RST" rather than "TEX$RST" for the
  107.     fonts.  This command is meaningless for the PK version of DVIDIS, and
  108.     of little use even in the RST version.
  109.  
  110. -d    Debug.  Generates a lot of output that's useful only to developers.
  111.  
  112. Program    Installation
  113.  
  114.  
  115. DVIDIS consists of a single image, DVIDIS.EXE, that runs on an VAXStation
  116. with VWS V3.0 or later.  It runs as a normal user-mode image, and needs no
  117. special privileges.  DVIDIS uses a fair amount of memory as it runs, so be
  118. sure to provide a reasonable working set - at least 1200 pages, 2000 or more
  119. is better.  In order for DVIDIS to receive its arguments, it must be started
  120. with a foreign command line, given by something like:
  121.  
  122.         $ DVIDIS :== $DEV:[DIR]DVIDIS
  123.  
  124. Two "environment variables" can be set to control DVIDIS, and you can specify
  125. font substitutions.  The environment variables - typically, logicals, but
  126. if no logicals are defined any DCL symbol of the same name will be used -
  127. are:
  128.  
  129. DVIDIS_FILE_FORMAT
  130.     A string that specifies how to construct a file specification for
  131.     a font file, given a font name and a dots-per-inch value.  The
  132.     font name will be substituted for %s; the dots-per-inch value for
  133.     %d.  You must have EXACTLY one of each, in either order; you may
  134.     NOT have any additional occurences of "%".
  135.  
  136.     There are two common schemes for storing PK font files:
  137.  
  138.         One directory, DEV:[DIR], font "name" at "ddd" dots
  139.         per inch is file name.dddPK.  A format string for
  140.         this case would look like "DEV:[DIR]%s.%dPK".
  141.  
  142.         One root directory, DEV:[DIR.]; fonts at "ddd" dots
  143.         per inch are in subdirectory [.DPIddd], with font
  144.         "name" in name.PK.  A format string for this case
  145.         would look like "DEV:[DIR.DPI%d]%s.PK".
  146.  
  147.     If DVIDIS_FILE_FORMAT is not defined, the default format string
  148.     is "TEX_FONTS:[DPI%d]%s.PK".  This corresponds to the second way
  149.     of organizing the font files, and assumes that TEX_FONTS is a
  150.     rooted logical translating to something like DEV:[DIR.].
  151.  
  152.     You can only specify a single file format, but that file format
  153.     could involve a logical that translates to a search list.  For
  154.     example, using the default file format, you might do:
  155.  
  156.         $ DEFINE TEX_FONTS $DISK1:[TEX.PK.],NODE::TEX_FONTS:
  157.  
  158.     where "NODE" is the name of a node with more fonts than you are
  159.     willing to store locally.  On NODE, TEX_FONTS must be a SYSTEM
  160.     logical name that translates to a rooted directory.  (If you
  161.     have proxy access to NODE, you could define TEX_FONTS in your
  162.     login file on NODE).  Because of a VMS bug, it isn't possible
  163.     to use something like NODE::DEV:[DIR.] to avoid needing a logical
  164.     name on NODE.  (This bug appears in VMS Version 4.5.  If you
  165.     a more recent version, the bug may have been fixed.)
  166.  
  167.             I M P O R T A N T   N O T E
  168.  
  169.     The definition of DVIDIS_FILE_FORMAT will be used as a printf()
  170.     format string.  The "d" and "s" format specifiers MUST be in
  171.     lower case; if you make them upper case, the format will not
  172.     work.  Note also that DCL forces characters to upper case unless
  173.     they are inside a quoted string.  Hence, your definition should
  174.     look something like:
  175.  
  176.         $ DEFINE DVIDIS_FILE_FORMAT "TEX_FONTS:%s.%dPK"
  177.  
  178. DVIDIS_FONT_SIZES
  179.     This variable must translate to a list of all dot-per-inch values
  180.     at which you have any fonts available.  The list consist of just
  181.     the numbers (the "ddd" values discussed above), separated by
  182.     commas.  DVIDIS will never find a font at a size not given in
  183.     the list.
  184.  
  185.     The default list is:
  186.  
  187.         100,121,145,174,180,208,210,225,240,250,263,270,274,
  188.         300,329,360,432,518,622,746,895,896,1074,1075,1289,
  189.         1290,1547,1548
  190.  
  191.     which is the list of values I've got.  Extra values will slow
  192.     DVIDIS down a bit when it has to open a file, but not by much,
  193.     so you can use the default unless you have some sizes I don't.
  194.  
  195.     Note that this list is NOT a search list, use:
  196.  
  197.         $ DEFINE DVIDIS_FONT_SIZES "300,329,360"
  198.  
  199.     WITH THE QUOTATION MARKS.  If you leave the quotation marks off,
  200.     DVIDIS will never use anything but the first value you list.
  201.  
  202. Font Substitution
  203.  
  204.  
  205. If DVIDIS is unable to find a font as specified, it will check to see if you
  206. have defined a substitute for it in any of three substitution files.  If you
  207. are displaying file jobname.DVI, the files are:
  208.  
  209.          jobname.SUB        in the same directory as jobname.DVI;
  210.         TEXFONTS.SUB        in the current directory;
  211.         TEX$INPUTS:TEXFONTS.SUB
  212.  
  213. Every time a substitution is needed, the files present are checked, in the
  214. order given, each from beginning to end, to try to find a substitute.  Only
  215. the first match is used, however.
  216.  
  217. Each of the substitution files has the same format.  It's a simple ASCII file,
  218. with one substitution per line.  Comments, as in TeX, are introduced by "%"
  219. and continue to the end of the line.
  220.  
  221. A substitution line has either of two forms:
  222.  
  223.     oldname.oldsize -> subname.subsize
  224.     oldname            -> subname
  225.  
  226. The first format substitutes only for a particular font name and size.  The
  227. second format substitutes for a particular font name at any size.
  228.  
  229. Spaces can be used freely in substitution lines.
  230.  
  231. Since only the first match is used, and the files are always read from the
  232. first line onward, you should specify particular substitutions - those with
  233. a size - before generic ones.
  234.  
  235. It's not an error for the substituted font file not to be found - DVIDIS will
  236. proceed to look for "nearby" fonts, possibly substituting for them as well.
  237.  
  238. The DVIDIS distribution includes a TEXFONTS.SUB file that substitutes CM fonts
  239. for AM fonts.  This should allow you to display DVI files created using older
  240. versions of TeX.
  241.  
  242. Getting the Find and Remove Keypad Keys to Work
  243.  
  244.  
  245. The Find and Remove keypad keys use OSC functions to control the terminal
  246. window.  OSC's must be enabled; from questions I've received, it seems that
  247. many people are not enabling them.  To enable OSC's, issue the following
  248. command from DCL (in a privileged account):
  249.  
  250.     $ DEFINE/SYSTEM/EXEC UIS$VT_ENABLE_OSC_STRINGS TRUE
  251.  
  252. Known Bugs and Restrictions
  253.  
  254.  
  255. If the original TeX run specified a magnification value other than 1000, the
  256. spacing will be incorrect.  The only current work-around is to re-run TeX
  257. without the magnification.
  258.  
  259. Author:  Jerry Leichter, based on work of Bill Gropp's, which in turn was
  260. based on a lot of earlier work by others; with additional input from Bert
  261. Beander at DEC.  Comments/questions/suggestions to Jerry Leichter at
  262.  
  263.         LEICHTER-JERRY@CS.YALE.EDU
  264.        or
  265.         LEICHTER@YALEVMS.BITNET
  266.